iT邦幫忙

2026 iThome 鐵人賽

DAY 29
0
AI 自動化

AI 公司模擬器:Discord x Multi-Agent 架構實作系列 第 29 篇

DAY 29|整理 README 與專案:讓別人也知道怎麼啟動這間 AI 公司

  • 分享至 

  • xImage
  •  

今天重整 README、設定範例與教學資料,並檢查文件中的指令是否符合目前程式。沒有再增加新的 Agent 功能,而是把已完成的流程說明清楚。

README 先回答:這個專案能做什麼?

README 開頭先交代這是一個 Python 學習專案:使用者在 Discord 提出需求,PM、Research、Creative、Finance 與 Review 分工討論,最後由會議啟動者選擇方向並批准成果。

五位 Agent 共用同一個模型服務,以不同提示詞、參數與輸出格式分工。Discord 上看到的角色卡片,也不是五個獨立 Bot 帳號。

這些說明放在安裝步驟之前,讀者才知道自己要啟動的是什麼。

README 也加入架構圖,把 Discord 入口、會議管理器、Agent、Ollama 與 MySQL 的關係放在一起。圖中除了模型呼叫,還畫出使用者選擇與批准,避免讓人以為 Review 通過就會自動定稿。

目前操作者仍能接受已顯示的剩餘風險並批准候選稿。這個限制直接寫在流程旁邊,不把「已完成」包裝成模型已保證方案正確。

https://ithelp.ithome.com.tw/upload/images/20261013/20183880mwwte8XpTv.png

把啟動順序寫完整

現在啟動 Bot 前,需要準備 Python 環境、Discord 帳號與權限、Ollama,以及 MySQL。README 依操作順序分段,讓讀者可以逐步確認:

  1. 取得程式,建立虛擬環境並安裝依賴。
  2. 設定 Discord Bot、邀請權限與頻道。
  3. 從 .env.example 建立自己的設定。
  4. 確認模型已安裝、Ollama 服務可用。
  5. 初始化全新的 MySQL,確認資料表存在。
  6. 檢查教學資料,再決定是否匯入。
  7. 執行測試與 Bot,在 Discord 查看基本指令。

每個階段都補上確認方式。讀者遇到問題時,可以先定位是哪個服務沒準備好,而不是一看到 Bot 無法操作,就重裝整個專案。

文件也區分新環境與已有資料的環境。例如匯入範例只適用全新資料庫;已有專案時不能當成一般啟動步驟反覆執行。

今天沒有在另一台電腦從頭部署,因此這份 README 是已核對的操作說明,還不能宣稱陌生使用者已照著完成全部安裝。

設定範例留空,讓使用者填自己的憑證

.env.example 用來告訴讀者需要哪些設定,不應提供可以直接拿來部署的示範密碼。三個必要憑證現在留空:

DISCORD_TOKEN=
DB_PASSWORD=
MYSQL_ROOT_PASSWORD=

真正的值由使用者填進自己的 .env,不要放進文章、截圖或 Git。資料庫應用帳號與管理帳號也要使用不同的強密碼。

模型範例使用 qwen3.5:9b,文件另外註明:若未設定模型,程式預設仍是 qwen3.5:4b。設定範例與程式預設不完全相同,就需要說清楚,否則排錯時容易以為兩邊本來應該一致。

資料庫名稱、連線位置、頻道 ID 與重試設定也一起核對。已有 .env 時不覆蓋,讓使用者對照新增欄位補齊即可。

教學資料和自己的會議紀錄分開

專案早期使用 JSON,後來正式 Bot 改為 MySQL。根目錄仍可能留下舊專案與會議紀錄,如果讀者直接拿它們匯入,就可能連同別人的成果與狀態一起載入。

因此新增 examples/,放五個獨立的虛構專案。每個專案都是 pending,各有一個需求變更;另外提供空白的伺服器與會議檔,沒有附上真實討論內容。

先執行專案自己的匯入腳本預檢:

python scripts/migrate_json_to_mysql.py --dry-run --projects-file examples/projects.json --guild-projects-file examples/empty-guild-projects.json --meetings-file examples/empty-meetings.json

這次預檢結果為 projects=5 guilds=0 meetings=0,只確認內容能讀取,不連線或寫入 MySQL。真正匯入要另外使用 --apply,而且先確認目標是新資料庫。

README 特別提醒,匯入會更新相同 ID 的資料,不能把它理解成「只補上缺少的範例」。也不能省略檔案路徑,避免腳本讀到根目錄的私人紀錄。

這次只做預檢,沒有把教學範例匯入既有資料庫。

目錄整理,先讓責任看得出來

明天我把github的網址貼出來,這樣目錄更一目了然。

今天我會把不需要的東西都刪掉。

第一次操作要有一條清楚的路線

README 列出目前 14 個 Slash Command 與 2 個文字指令,但新手不需要一開始就記住全部指令。

第一次操作先從 /projects 找到範例,再依序進行 /start、可選的 /change、/draft 與 /review。接著由啟動者選方向,閱讀候選方案與風險,再批准或駁回。

自然語言入口則另行說明:在指定頻道描述需求,依提示補欄位與確認,不必先學會所有參數。未完成的填表對話仍是暫存,Bot 重啟不會恢復;已保存的專案與會議則在 MySQL。

指令表也寫上限制。例如 /resume 是接續討論失敗步驟,不能當成所有錯誤的通用重試;/cleanup 清理 Bot 訊息,不會取消專案或重置資料庫。

整理完,還有哪些事沒有證明?

.gitignore 補上憑證變體、日誌、私人備份與測試產物,保留 .env.example 可追蹤。既有會議資料和資料庫沒有為了整理而清空,系統雜檔則以可恢復方式移走。

但忽略規則不會撤回已經提交的秘密。工作檔掃描沒有找到目前憑證,不代表 Git 歷史一定乾淨;憑證若曾外洩,仍須撤銷換新。

另一個需要寫清楚的界線是:模型在本機推論,不等於整個專案完全離線。需求會經過 Discord,完整的 Agent 輸入與輸出也會保存到 MySQL,使用者不能因此放心貼入不能分享的資料。

把專案介紹、啟動方式、資料來源與操作限制整理成可以查閱的文件。接下來若要確認它真的容易上手,還需要在新環境照 README 走一次,而不是只靠文件測試就宣稱部署成功。


上一篇
DAY 28|把 AI 公司完整跑一遍:測試流程,也檢查方案內容
下一篇
DAY 30|在 Discord 展示 AI 公司:從需求、分歧到使用者決策
系列文
AI 公司模擬器:Discord x Multi-Agent 架構實作 共 30 篇
圖片
  熱門推薦
圖片
{{ item.channelVendor }} | {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言